<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Number Format Value Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">NumberFormatValue Structure</p>
<h1>Structure Overview</h1>
<div class="section-text">
Used to format a numeric value.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Number Format Value</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
</table>

<h3>Property Summary</h3>

<dl class="section-text">
<dt><a href="#Property-category">category</a></dt>
<dd>Provides a list of pre-defined number formatter, <i>General Number</i>, <i>Currency</i>, <i>Fixed</i>, etc.</dd>
<dt><a href="#Property-locale">locale</a></dt>
<dd></dd>
<dt><a href="#Property-pattern">pattern</a></dt>
<dd>Pattern of the number formatter.</dd>
</dl>

<h3>Description</h3>

<div class="section-text">
<p>Provides a set of pre-defined number formatter, or user can define a customized formatter
given a pattern.</p></div>
<h1>Property Detail</h1>

<h2><a name="Property-category">category Property</a></h2>

<p class="section-text">Provides a list of pre-defined number formatter, <i>General Number</i>, <i>Currency</i>, <i>Fixed</i>, etc.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#choice">choice</a> (numberFormat)</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Category</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
</table>

<h3>Choices</h3>

<table class="section-table">
<thead><tr><td>Name</td><td>Display Name</td>
<td>Value</td><td>Description</td></tr></thead>
<tbody>
<tr><td>Unformatted</td>
<td>Unformatted</td>
<td>Unformatted</td>
<td></td></tr>
<tr><td>General Number</td>
<td>General Number</td>
<td>General Number</td>
<td></td></tr>
<tr><td>Currency</td>
<td>Currency</td>
<td>Currency</td>
<td></td></tr>
<tr><td>Fixed</td>
<td>Fixed</td>
<td>Fixed</td>
<td></td></tr>
<tr><td>Percent</td>
<td>Percent</td>
<td>Percent</td>
<td></td></tr>
<tr><td>Scientific</td>
<td>Scientific</td>
<td>Scientific</td>
<td></td></tr>
<tr><td>Standard</td>
<td>Standard</td>
<td>Standard</td>
<td></td></tr>
<tr><td>Custom</td>
<td>Custom</td>
<td>Custom</td>
<td></td></tr>
</tbody></table><br>
<h3>Description</h3>

<div class="section-text">
<p>Allow user to choose from a list of pre-defined number formatter. Use a certain formatter to convert
a "number" typed value using the given formatter.</p></div>

<hr>
<h2><a name="Property-locale">locale Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#locale">locale</a></td></tr>
<tr><td>Since:</td>
<td>2.5</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Locale</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
</table>


<hr>
<h2><a name="Property-pattern">pattern Property</a></h2>

<p class="section-text">Pattern of the number formatter.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Pattern</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Pattern of the number formatter.</p></div>
</body>
</html>
